feat: pass additionalCommandArgs to barman-cloud-restore by armru · Pull Request #914 · cloudnative-pg/plugin-barman-cloud

armru · 2026-05-18T09:53:19Z

An ObjectStore already lets users tack extra command-line flags onto three of the four barman-cloud-* invocations: barman-cloud-backup via
data.additionalCommandArgs, barman-cloud-wal-archive via wal.archiveAdditionalCommandArgs, and barman-cloud-wal-restore via
wal.restoreAdditionalCommandArgs. The fourth — barman-cloud-restore, the actual data-restore step in PITR and recovery-from-object-store — has had no
equivalent, which is exactly the gap reported in #821 (the asker wanted a longer --read-timeout for slow restores from S3).

This PR fills that gap by adding spec.configuration.data.restoreAdditionalCommandArgs and wiring it into the recovery job hook. In restoreDataDir,
the user-supplied flags are appended after the cloud-provider options and --endpoint-url but before the positional (destinationPath, serverName, backupID, pgdata) arguments — same shape as the other three knobs. The library's existing append/dedup logic still wins on conflicts, so users can't
accidentally override flags the plugin already sets (--cloud-provider, --endpoint-url, etc.).

Sister PR (must merge first)

The CRD field is generated from the BarmanObjectStoreConfiguration Go type in cloudnative-pg/barman-cloud, so the actual API change lives upstream:
cloudnative-pg/barman-cloud#242 — which adds DataBackupConfiguration.RestoreAdditionalCommandArgs and the AppendRestoreAdditionalCommandArgs
helper. Once that PR merges and a barman-cloud release is cut, controller-gen here picks up the new field automatically.

go.mod is temporarily pinned to cloudnative-pg/barman-cloud#242 HEAD commit via a pseudo-version (v0.5.2-0.20260513095406-dac43abc6cf6) so CI on this branch can run
end-to-end against the unreleased upstream change. This pin must be replaced with a tagged barman-cloud release before this PR can merge.

Closes #821

An ObjectStore lets users tack extra command-line flags onto four of the six barman-cloud-* invocations the plugin shells out to: barman-cloud-backup (data.additionalCommandArgs), -wal-archive (wal.archiveAdditionalCommandArgs), -wal-restore (wal.restoreAdditionalCommandArgs), and -restore (data.restoreAdditionalCommandArgs, PR cloudnative-pg#914). The remaining two -- barman-cloud-backup-show (post-write verification) and barman-cloud-backup-list (retention pruning) -- had no equivalent, which is the gap reported in cloudnative-pg#712. On strictly-vhost S3-compatible endpoints users need `--addressing-style=virtual` on every cloud command, and currently those two reject the user-provided args, marking otherwise-successful backups as failed and silently disabling retention pruning. The library-side change adds the two new fields and helpers (sister PR in cloudnative-pg/barman-cloud) and threads them through GetBackupList / GetBackupByName. This plugin commit just exposes them via the CRD and documents the new shape. ## Sister PR (must merge first) The CRD field schema is generated from the BarmanObjectStoreConfiguration Go type in cloudnative-pg/barman-cloud. The sister PR there adds: - DataBackupConfiguration.ShowAdditionalCommandArgs []string - DataBackupConfiguration.ListAdditionalCommandArgs []string - AppendShowAdditionalCommandArgs / AppendListAdditionalCommandArgs helpers Once that PR merges and a barman-cloud release is cut, controller-gen here picks up the new fields automatically. Until then a developer running \`go test ./...\` against this branch needs a local replace directive in go.mod pointing at the barman-cloud branch (omitted from this commit). Closes cloudnative-pg#712

An ObjectStore lets users tack extra command-line flags onto four of the six barman-cloud-* invocations the plugin shells out to: barman-cloud-backup (data.additionalCommandArgs), -wal-archive (wal.archiveAdditionalCommandArgs), -wal-restore (wal.restoreAdditionalCommandArgs), and -restore (data.restoreAdditionalCommandArgs, PR cloudnative-pg#914). The remaining two -- barman-cloud-backup-show (post-write verification) and barman-cloud-backup-list (retention pruning) -- had no equivalent, which is the gap reported in cloudnative-pg#712. On strictly-vhost S3-compatible endpoints users need `--addressing-style=virtual` on every cloud command, and currently those two reject the user-provided args, marking otherwise-successful backups as failed and silently disabling retention pruning. The library-side change adds the two new fields and helpers (sister PR in cloudnative-pg/barman-cloud) and threads them through GetBackupList / GetBackupByName. This plugin commit just exposes them via the CRD and documents the new shape. ## Sister PR (must merge first) The CRD field schema is generated from the BarmanObjectStoreConfiguration Go type in cloudnative-pg/barman-cloud. The sister PR there adds: - DataBackupConfiguration.ShowAdditionalCommandArgs []string - DataBackupConfiguration.ListAdditionalCommandArgs []string - AppendShowAdditionalCommandArgs / AppendListAdditionalCommandArgs helpers Once that PR merges and a barman-cloud release is cut, controller-gen here picks up the new fields automatically. Until then a developer running \`go test ./...\` against this branch needs a local replace directive in go.mod pointing at the barman-cloud branch (omitted from this commit). Closes cloudnative-pg#712 Signed-off-by: David Almgren <dalmgren@coreweave.com>

Add support for the new `spec.configuration.data.restoreAdditionalCommandArgs` field so operators can append flags (e.g. `--read-timeout`) to barman-cloud-restore invocations, mirroring the existing `wal.restoreAdditionalCommandArgs` behavior. The new field is consumed by `restoreDataDir` and applied after the cloud provider options and `--endpoint-url` but before the positional arguments, so the upstream append/dedup logic can filter attempts to override official options. Depends on the corresponding upstream `barman-cloud` change in PR #242, which introduces `DataBackupConfiguration.RestoreAdditionalCommandArgs` and `AppendRestoreAdditionalCommandArgs`. go.mod pins that dependency to the PR HEAD commit via a pseudo-version; bump it to a tagged release once barman-cloud cuts one containing #242. Closes #821 Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>

Extend the "Extra Options" section in `misc.md` to cover `barman-cloud-restore` alongside backup and WAL archiving, and add a usage example for `.spec.configuration.data.restoreAdditionalCommandArgs`. Refs #821 Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>

The 'Extra Options' section enumerated every additionalCommandArgs knob except wal.restoreAdditionalCommandArgs, which already existed in the API. Add the missing bullet and example so the list is complete. Signed-off-by: Armando Ruocco <armando.ruocco@enterprisedb.com>

Signed-off-by: Leonardo Cecchi <leonardo.cecchi@gmail.com>

…ud (v0.12.0 ➔ v0.13.0) (#10) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [cloudnative-pg/plugin-barman-cloud](https://github.com/cloudnative-pg/plugin-barman-cloud) | minor | `v0.12.0` → `v0.13.0` | --- ### Release Notes <details> <summary>cloudnative-pg/plugin-barman-cloud (cloudnative-pg/plugin-barman-cloud)</summary> ### [`v0.13.0`](https://github.com/cloudnative-pg/plugin-barman-cloud/releases/tag/v0.13.0) [Compare Source](cloudnative-pg/plugin-barman-cloud@v0.12.0...v0.13.0) ##### Features - Configure k8s recommended labels on subresources ([#865](cloudnative-pg/plugin-barman-cloud#865)) ([4bbaf18](cloudnative-pg/plugin-barman-cloud@4bbaf18)), closes [#545](cloudnative-pg/plugin-barman-cloud#545) - Pass additionalCommandArgs to barman-cloud-restore ([#914](cloudnative-pg/plugin-barman-cloud#914)) ([c5f149b](cloudnative-pg/plugin-barman-cloud@c5f149b)), closes [#821](cloudnative-pg/plugin-barman-cloud#821) ##### Bug Fixes - Add lz4 compression support for base backups ([#868](cloudnative-pg/plugin-barman-cloud#868)) ([e30154b](cloudnative-pg/plugin-barman-cloud@e30154b)), closes [#867](cloudnative-pg/plugin-barman-cloud#867) - Classify WAL restore errors with precise gRPC statuses ([#927](cloudnative-pg/plugin-barman-cloud#927)) ([aaf6120](cloudnative-pg/plugin-barman-cloud@aaf6120)) - **deps:** Update all non-major go dependencies ([#877](cloudnative-pg/plugin-barman-cloud#877)) ([a81f6e3](cloudnative-pg/plugin-barman-cloud@a81f6e3)) - **deps:** Update all non-major go dependencies ([#898](cloudnative-pg/plugin-barman-cloud#898)) ([acdbfb8](cloudnative-pg/plugin-barman-cloud@acdbfb8)) - **deps:** Update all non-major go dependencies to [`5d46599`](cloudnative-pg/plugin-barman-cloud@5d46599) ([#940](cloudnative-pg/plugin-barman-cloud#940)) ([40aa4b2](cloudnative-pg/plugin-barman-cloud@40aa4b2)) - **deps:** Update all non-major go dependencies to [`8e1642e`](cloudnative-pg/plugin-barman-cloud@8e1642e) ([#939](cloudnative-pg/plugin-barman-cloud#939)) ([f708825](cloudnative-pg/plugin-barman-cloud@f708825)) - **deps:** Update all non-major go dependencies to [`bd68198`](cloudnative-pg/plugin-barman-cloud@bd68198) ([#950](cloudnative-pg/plugin-barman-cloud#950)) ([787d2b3](cloudnative-pg/plugin-barman-cloud@787d2b3)) - **deps:** Update documentation dependencies to v3.10.1 ([#878](cloudnative-pg/plugin-barman-cloud#878)) ([6cf473d](cloudnative-pg/plugin-barman-cloud@6cf473d)) - **deps:** Update k8s.io/utils digest to [`ff6756f`](cloudnative-pg/plugin-barman-cloud@ff6756f) ([#894](cloudnative-pg/plugin-barman-cloud#894)) ([b7389e1](cloudnative-pg/plugin-barman-cloud@b7389e1)) - **deps:** Update kubernetes monorepo to v0.35.4 ([#853](cloudnative-pg/plugin-barman-cloud#853)) ([21f811a](cloudnative-pg/plugin-barman-cloud@21f811a)) - **deps:** Update kubernetes monorepo to v0.36.1 ([#909](cloudnative-pg/plugin-barman-cloud#909)) ([99eb4a3](cloudnative-pg/plugin-barman-cloud@99eb4a3)) - **deps:** Update module github.com/cloudnative-pg/cloudnative-pg to v1.29.1 \[security] ([#902](cloudnative-pg/plugin-barman-cloud#902)) ([ba5063f](cloudnative-pg/plugin-barman-cloud@ba5063f)) - **deps:** Update module github.com/cloudnative-pg/machinery to v0.5.0 ([#925](cloudnative-pg/plugin-barman-cloud#925)) ([ef4b711](cloudnative-pg/plugin-barman-cloud@ef4b711)) - **deps:** Update module github.com/onsi/ginkgo/v2 to v2.28.2 ([#874](cloudnative-pg/plugin-barman-cloud#874)) ([8cb32e5](cloudnative-pg/plugin-barman-cloud@8cb32e5)) - **deps:** Update module google.golang.org/grpc to v1.81.0 ([#884](cloudnative-pg/plugin-barman-cloud#884)) ([6fdecfd](cloudnative-pg/plugin-barman-cloud@6fdecfd)) - **deps:** Update module sigs.k8s.io/controller-runtime to v0.24.0 ([#880](cloudnative-pg/plugin-barman-cloud#880)) ([58f4fed](cloudnative-pg/plugin-barman-cloud@58f4fed)) - **deps:** Update module sigs.k8s.io/controller-runtime to v0.24.1 ([#910](cloudnative-pg/plugin-barman-cloud#910)) ([9be87b0](cloudnative-pg/plugin-barman-cloud@9be87b0)) - **docs:** Update broken link to CloudNativePG documentation ([#904](cloudnative-pg/plugin-barman-cloud#904)) ([43f92fb](cloudnative-pg/plugin-barman-cloud@43f92fb)), closes [#729](cloudnative-pg/plugin-barman-cloud#729) - **scheme:** Register meta types for CNPG scheme group version ([#943](cloudnative-pg/plugin-barman-cloud#943)) ([bb7845d](cloudnative-pg/plugin-barman-cloud@bb7845d)), closes [#942](cloudnative-pg/plugin-barman-cloud#942) </details> --- ### Configuration 📅 **Schedule**: (in timezone Europe/Warsaw) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.ajgon.casa/deedee/mark13/pulls/10

armru requested a review from a team as a code owner May 18, 2026 09:53

dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. dependencies Pull requests that update a dependency file enhancement New feature or request go Pull requests that update go code labels May 18, 2026

armru force-pushed the dev/821 branch 2 times, most recently from 7be2e2c to 01f1956 Compare May 18, 2026 10:01

GabriFedi97 reviewed May 21, 2026

View reviewed changes

Comment thread web/docs/misc.md

This was referenced May 26, 2026

feat: add ShowAdditionalCommandArgs and ListAdditionalCommandArgs cloudnative-pg/barman-cloud#249

Open

feat: expose showAdditionalCommandArgs and listAdditionalCommandArgs #924

Open

armru added 3 commits June 3, 2026 11:31

leonardoce force-pushed the dev/821 branch from 01f1956 to bbb2c0a Compare June 3, 2026 09:32

chore: review

80dda82

Signed-off-by: Leonardo Cecchi <leonardo.cecchi@gmail.com>

leonardoce approved these changes Jun 3, 2026

View reviewed changes

dosubot Bot added the lgtm This PR has been approved by a maintainer label Jun 3, 2026

leonardoce merged commit c5f149b into main Jun 3, 2026
8 checks passed

leonardoce deleted the dev/821 branch June 3, 2026 12:17

cnpg-bot mentioned this pull request Jun 3, 2026

chore(main): release 0.13.0 #860

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: pass additionalCommandArgs to barman-cloud-restore#914

feat: pass additionalCommandArgs to barman-cloud-restore#914
leonardoce merged 4 commits into
mainfrom
dev/821

armru commented May 18, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

armru commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Sister PR (must merge first)

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

armru commented May 18, 2026 •

edited

Loading